package com.example.ddz.framework;

/**
 * Created by IntelliJ IDEA.
 * User: Marcel Melzig
 * Date: 27.07.11
 * Time: 18:39
 */

import java.util.List;

import android.view.View.OnTouchListener;

import com.example.ddz.framework.IInput.TouchEvent;

/**
 * The touch handler interface defines the methods every touch handler implementation must implement.
 */
public interface ITouchHandler extends OnTouchListener
{
    /**
     * The touch down state.
     *
     * @param pointer The pointer of the event.
     * @return True if the pointer is touched down, otherwise false.
     */
    public boolean IsTouchDown(int pointer);

    /**
     * The x coordinate of the pointer.
     *
     * @param pointer The pointer of the event.
     * @return The pointers x coordinate.
     */
    public int GetTouchX(int pointer);

    /**
     * The y coordinate of the pointer.
     *
     * @param pointer The pointer of the event.
     * @return The y coordinate.
     */
    public int GetTouchY(int pointer);

    /**
     * Gets a list of touch events.
     *
     * @return A list of touch events.
     */
    public List<TouchEvent> GetTouchEvents();
}
